Skip to content

Keep AI as the getting started path#243

Merged
toddgeist merged 1 commit intomainfrom
feature/deal-with-getting-started
May 6, 2026
Merged

Keep AI as the getting started path#243
toddgeist merged 1 commit intomainfrom
feature/deal-with-getting-started

Conversation

@toddgeist
Copy link
Copy Markdown
Contributor

@toddgeist toddgeist commented May 6, 2026 •
edited by coderabbitai Bot
Loading

Summary

  • Reframes the Web Viewer package page as direct-use @proofkit/webviewer reference instead of a general Getting Started page.
  • Moves the package page next to the Web Viewer landing page in the sidebar while keeping API mechanics under Reference.
  • Points new users from Web Viewer docs back to the ProofKit AI getting started path.

Test plan

  • pnpm run ci

Summary by CodeRabbit

  • Documentation
    • Renamed Better Auth documentation page title to "Introduction"
    • Restructured WebViewer package documentation with streamlined layout, new overview section, and "Add it to an existing app" guide
    • Updated documentation navigation structure
    • Added callout blocks for user guidance

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 6, 2026

⚠️ No Changeset found

Latest commit: 58a099f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown

vercel Bot commented May 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
proofkit-docs Ready Ready Preview May 6, 2026 4:28pm

Request Review

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 6, 2026

Open in StackBlitz

@proofkit/better-auth

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/better-auth@243

@proofkit/cli

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/cli@243

create-proofkit

pnpm add https://pkg.pr.new/proofsh/proofkit/create-proofkit@243

@proofkit/fmdapi

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/fmdapi@243

@proofkit/fmodata

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/fmodata@243

@proofkit/typegen

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/typegen@243

@proofkit/webviewer

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/webviewer@243

commit: 58a099f

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026 •
edited
Loading

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

Documentation updates across two separate doc sections: better-auth page title renamed from "Getting Started" to "Introduction," and webviewer docs restructured with new metadata organization, index callout addition, and package page content rewrite.

Changes

Better-auth Documentation Title Update

Layer / File(s) Summary
Page Title
apps/docs/content/docs/better-auth/index.mdx		 Page title changed from "Getting Started" to "Introduction".

Webviewer Documentation Restructuring

Layer / File(s) Summary
Navigation Structure
apps/docs/content/docs/webviewer/meta.json		 Added "package" entry after "index" in pages array and removed legacy formatting tags; section order adjusted to bring "---Reference---" earlier.
Index Page Enhancement
apps/docs/content/docs/webviewer/index.mdx		 Callout component imported and "New to ProofKit?" callout block inserted into the page.
Package Page Restructuring
apps/docs/content/docs/webviewer/package.mdx		 Front matter updated with new title and description; old Getting Started content replaced with streamlined overview, callout for new users, deployment notes, installation guide, and new Related reference section with links to API docs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • proofsh/proofkit#239: Modifies the same webviewer documentation files with overlapping changes to the "New to ProofKit" callout and page structure.
  • proofsh/proofkit#233: Updates the same webviewer and docs files as part of a broader docs refresh affecting index, meta, and package pages.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is related to the PR's main objective of reframing the Web Viewer package page and keeping the AI path as the primary getting started route, but it is somewhat vague and doesn't clearly convey the specific structural changes being made to the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/deal-with-getting-started

Comment @coderabbitai help to get the list of available commands and usage tips.

@toddgeist toddgeist merged commit 8da6a98 into main May 6, 2026
13 checks passed
@toddgeist toddgeist deleted the feature/deal-with-getting-started branch May 6, 2026 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@toddgeist